Add PostMountMethodSignatureRule
#10
Conversation
Kocal
force-pushed
the
PostMountMethodSignatureRule
branch
from
23d0d14 to
3546da6
Compare
Kocal
force-pushed
the
PostMountMethodSignatureRule
branch
2 times, most recently
from
bb09df6 to
77f7112
Compare
There was a problem hiding this comment.
Pull request overview
This PR adds a new PostMountMethodSignatureRule to validate methods with the #[PostMount] attribute and refactors the existing PreMountMethodSignatureRule to allow more flexible method signatures. Both rules now use PHPStan's reflection API for more robust validation and allow optional parameters (0 or 1 array parameter) and multiple return types (array, void, or array|void).
Key changes:
- Added
PostMountMethodSignatureRulewith validation for public visibility, optional array parameter, and array/void/array|void return types - Refactored
PreMountMethodSignatureRuleto useReflectionProviderinstead of AST-only validation and updated signature requirements to match PostMount - Reorganized and consolidated test fixtures for better clarity and coverage
Reviewed changes
Copilot reviewed 32 out of 34 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Rules/TwigComponent/PreMountMethodSignatureRule.php | Refactored to use reflection-based validation, now allows optional parameter and void/array return types |
| src/Rules/TwigComponent/PostMountMethodSignatureRule.php | New rule implementing same validation logic as PreMount for PostMount lifecycle hook |
| tests/Rules/TwigComponent/PreMountMethodSignatureRule/PreMountMethodSignatureRuleTest.php | Reorganized tests into focused test methods per validation concern |
| tests/Rules/TwigComponent/PreMountMethodSignatureRule/Fixture/*.php | Consolidated and renamed test fixtures for clarity (e.g., InvalidNotPublic → InvalidVisibility) |
| tests/Rules/TwigComponent/PostMountMethodSignatureRule/**/*.php | Complete test suite for new PostMount rule with all validation scenarios |
| tests/Rules/TwigComponent/ClassNameShouldNotEndWithComponentRule/**/*.php | Renamed fixture files and fixed class names to be more descriptive |
| tests/Rules/TwigComponent/ForbiddenAttributesPropertyRule/Fixture/ComponentWithCustomAttributesProperty.php | Fixed class name to match filename |
| README.md | Added documentation for PostMountMethodSignatureRule with examples; updated PreMountMethodSignatureRule description (though inaccurate) |
| phpstan.dist.neon | Removed missingType.return and return.unusedType from ignore list (improved code quality) |
| ecs.php | Generalized ProtectedToPrivateFixer skip pattern to cover all test fixtures |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /** | ||
| * @implements Rule<Node\Stmt\Class_> |
There was a problem hiding this comment.
Inconsistent PHPDoc annotation. This rule uses @implements Rule<Node\Stmt\Class_> while PreMountMethodSignatureRule and other rules in the codebase use @implements Rule<Class_> (with the import use PhpParser\Node\Stmt\Class_). For consistency with other rules, change to @implements Rule<Class_> and add the import use PhpParser\Node\Stmt\Class_ at the top.
| $reflClass = $this->reflectionProvider->getClass($node->namespacedName->toString()); | ||
| $errors = []; |
There was a problem hiding this comment.
[nitpick] Inconsistent variable declaration order between lines 43-44. In PreMountMethodSignatureRule (line 44-45), $errors is declared before $reflClass, but here it's reversed. For consistency, consider using the same order: $errors = []; followed by $reflClass = ....
| $reflClass = $this->reflectionProvider->getClass($node->namespacedName->toString()); | |
| $errors = []; | |
| $errors = []; | |
| $reflClass = $this->reflectionProvider->getClass($node->namespacedName->toString()); |
Kocal
force-pushed
the
PostMountMethodSignatureRule
branch
from
77f7112 to
055bb6b
Compare
No description provided.